Skip to content

feat: introduce automated tag and release process in maintainer guide #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 7, 2025

Conversation

DevelopmentCats
Copy link
Contributor

Description

Add the new automated Release process to MAINTAINER.md, and moved the tag_release.sh script to /scripts

Type of Change

  • New module
  • Bug fix
  • Feature/enhancement
  • Documentation
  • Other

Testing & Validation

  • Tests pass (bun test)
  • Code formatted (bun run fmt)
  • Changes tested locally

Related Issues

None

@DevelopmentCats DevelopmentCats requested a review from bpmct August 1, 2025 15:31
1. **Checkout the merge commit:**

```bash
git checkout MERGE_COMMIT_ID
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this handle multiple unreleased modules if they are merged through multiple commits but haven't been released in a while?

I guess if we checkout the most latest merge commit the script will see all modules available (even the ones merged previously but unreleased) and tag them all at the currently checked out module.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there are previous commits that have not been released before he current commit, it would include them in the release process.

I originally thought that this might be a problem, but figured that it might ensure that we never have forgotten unreleased modules if we use this script often.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess if we wrote this into a workflow we could essentially detect it on every commit and automatically release it if I wrote in a way to suppress the confirmation message

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

: 🚀

@matifali matifali enabled auto-merge (squash) August 7, 2025 07:18
@matifali matifali requested a review from Copilot August 7, 2025 07:18
@matifali matifali disabled auto-merge August 7, 2025 07:18
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces an automated tag and release process for maintainers by adding detailed documentation to the MAINTAINER.md file and relocating the tag_release.sh script to a scripts directory. The changes streamline the release workflow by providing maintainers with a comprehensive guide for using the automated tagging system.

  • Added detailed documentation for the automated tag and release process with prerequisites, steps, and example output
  • Reorganized the release section to prioritize the automated approach while keeping manual process as fallback
  • Moved tag_release.sh script to /scripts directory for better organization

2. **Run the tag release script:**

```bash
./scripts/tag_release.sh
Copy link
Preview

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation references ./scripts/tag_release.sh but there's no indication in this PR that the script was actually moved to the scripts directory. Consider verifying the script location or updating the path if the move hasn't occurred yet.

Suggested change
./scripts/tag_release.sh
./tag_release.sh

Copilot uses AI. Check for mistakes.

@matifali matifali merged commit 0333399 into main Aug 7, 2025
4 checks passed
@matifali matifali deleted the cat/maintainer-update branch August 7, 2025 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants